timezone-support
Advanced tools
Package description
The timezone-support npm package provides utilities for working with time zones, including converting dates between time zones, parsing and formatting dates, and handling daylight saving time transitions.
Convert Date Between Time Zones
This feature allows you to convert a date from one time zone to another. The code sample demonstrates converting a UTC date to 'America/New_York' time zone.
const { convertTimeToTimeZone } = require('timezone-support');
const { parseFromTimeZone, formatToTimeZone } = require('date-fns-timezone');
const date = new Date('2023-10-01T12:00:00Z');
const timeZone = 'America/New_York';
const convertedDate = convertTimeToTimeZone(date, { timeZone });
console.log(convertedDate);Parse Date from Time Zone
This feature allows you to parse a date string in a specific time zone. The code sample demonstrates parsing a date string in the 'America/New_York' time zone.
const { parseFromTimeZone } = require('timezone-support');
const dateStr = '2023-10-01 12:00:00';
const timeZone = 'America/New_York';
const parsedDate = parseFromTimeZone(dateStr, { timeZone });
console.log(parsedDate);Format Date to Time Zone
This feature allows you to format a date to a specific time zone. The code sample demonstrates formatting a UTC date to 'America/New_York' time zone with a specific format.
const { formatToTimeZone } = require('timezone-support');
const date = new Date('2023-10-01T12:00:00Z');
const timeZone = 'America/New_York';
const format = 'YYYY-MM-DD HH:mm:ss [GMT]Z (z)';
const formattedDate = formatToTimeZone(date, { timeZone, format });
console.log(formattedDate);Moment-timezone is an add-on for Moment.js that provides time zone support. It allows you to parse, manipulate, and display dates in different time zones. Compared to timezone-support, moment-timezone is more widely used and has a larger community, but it requires Moment.js as a dependency.
Luxon is a modern JavaScript library for working with dates and times. It provides comprehensive time zone support and is designed to be a replacement for Moment.js. Luxon is more modern and has a smaller footprint compared to moment-timezone, but it offers similar functionalities to timezone-support.
Date-fns-tz is a time zone extension for date-fns, a modern JavaScript date utility library. It provides functions for working with time zones, including converting, parsing, and formatting dates. Date-fns-tz is modular and tree-shakeable, making it a lightweight alternative to timezone-support.
Readme
Lightweight time zone listing and date converting. Intended for adding time zone support to high-level date libraries, but also for direct application usage.
const {
listTimeZones, findTimeZone, getZonedTime, getUnixTime
} = require('timezone-support')
// List canonical time zone names: [ 'Africa/Abidjan', ... ]
const timeZones = listTimeZones()
// Find a particular time zone: { name: 'Europe/Berlin', ... }
const berlin = findTimeZone('Europe/Berlin')
// Convert a date to a specific time zone: { year, month, day, dayOfWeek,
// hours, minutes, seconds, milliseconds, epoch, zone: { abbreviation, offset } }
const nativeDate = new Date()
const berlinTime = getZonedTime(nativeDate, berlin)
// Convert a time from a specific time zone: native Date object
const berlinTime = { year: 2018, month: 9, day: 2, hours: 10, minutes: 0 }
const nativeDate = new Date(getUnixTime(berlinTime, berlin))
This module can be installed in your project using NPM or [Yarn]. Make sure, that you use Node.js version 6 or newer.
$ npm i timezone-support --save
$ yarn add timezone-support
Functions are exposed as named exports from the package modules, for example:
const { findTimeZone, getZonedTime } = require('timezone-support')
You can read more about the module loading in other environments, like with ES6 or in web browsers. Usage scenarios demonstrate applications of this library in typical real-world scenarios. Design concepts explain the approach to time zone handling taken by tni library and types of values used ion the interface. Generating custom time zone data will allow you to save the overall package size by limiting the supported year span. Finally, the API reference lists all functions with a description of their functionality.
Date object.In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Copyright (c) 2018 Ferdinand Prantl
Licensed under the MIT license.
FAQs
Lightweight time zone support for your applications or other date libraries.
The npm package timezone-support receives a total of 140,630 weekly downloads. As such, timezone-support popularity was classified as popular.
We found that timezone-support demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.